/**
 * 用于解析中文句子评分结果<br>
 *
 * @module ChiVoxSDK/score
 * @author Don Li <kai.li@chivox.com>
 * @licence
 * Copyright (c) 2017 - 2020 ChiVox Inc. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

 /**
 * 中文句子评分结果类。
 */
class CnSentScore {
    constructor(data) { this.data = data; }

    /**
     * 获得用户设置的评分参数（部分参数经过了过滤处理）
     */
    getParams() {
        return this.data.params;
    }

    /**
     * 获得本次评分的录音id。<br>
     * 在startRecord的时候，服务器生成的一个唯一的id，并回传给客户端
     */
    getRecordId() {
        return this.data.recordId;
    }

    /**
     * 获得本次请求的录音文件地址
     * @return {string}
     */
    getAudioUrl() {
        return this.data.audioUrl;
    }

    /**
     * 判断是否评分错误
     * @return {boolean}
     */
    hasError() {
        var r = false;
        if (typeof this.data.result == "undefined" || typeof this.data.result["err"] != "undefined" || typeof this.data.result["error"] != "undefined" || typeof this.data.result["errID"] != "undefined") {
            r = true;
        }
        return r;
    }

    /**
     * 获得错误码。如果不存在错误，则无返回值。
     * @return {int}
     */
    getErrorCode() {
        if (this.hasError()) {
            if (typeof this.data.result != "undefined" && this.data.result["errID"] != "undefined") {
                return this.data.result["errID"];
            } else {
                return this.data["error"];
            }
        }
        return;
    }

    /**
     * 本次评分的分制
     * @return {int}
     */
    getRank() {
        return this.data.result["rank"];
    }

    /**
     * 词整体等级：综合考虑了 无调发音(phn)、声调(tone)。
     * @return {int}
     */
    getOverall() {
        return this.data.result["overall"];
    }

    /**
     * 带调发音等级：综合考虑了 无调发音(phn)、声调(tone)， 同overall。
     * @return {int}
     */
    getPron() {
        return this.data.result["pron"];
    }

    /**
     * 无调发音等级：字词包含的所有无调拼音的发音整体水平,即声母，韵母发音的综合评分。
     * @return {int}
     */
    getPhn(){
        return this.data.result["phn"];
    }

    /**
     * 声调等级： 字词包含的所有声调的整体水平。
     * @return {int}
     */
    getToneScore() {
        return this.data.result["tone"];
    }

    /**
     * 句子的流利度评分。
     * @return {int}
     */
    getFluency() {
        return this.data.result["fluency"].overall;
    }

    /**
     * 单词中音节（单字）的个数。其中元素的顺序和单词中单字出现的顺序一致。
     * @return {int}
     */
    getCharSize() {
        return this.data.result["details"].length;
    }

    /**
     * 单词中第i个音节（单字）的评分结果。
     * @return {chivox.CnSentScore.Char}
     */
    getChar(i) {
        var charI = this.data.result["details"][i];
        return new Char(charI);
    }
}

/**
 * Char 类，用于解析中文句子评分结果中details部分<br>
 * 中文句子评分结果char类
 */
class Char {
    constructor(data) { this.data = data; }

    /**
     * 声调置信度百分制得分（用于声调曲线绘制）。其中数组的每一位分别表示<br>
     * [轻声得分, 1声得分, 2声得分, 3声得分, 4声得分]<br>
     * 根据此系数，使用chivox API提供的声调曲线绘制功能可以绘制用户声调曲线。
     * @return {array}
     */
    getConfidence() {
        return this.data["confidence"];
    }

    /**
     * 音节的无调拼音串
     */
    getChar() {
        return this.data["char"];
    }

    /**
     * 音节的数字声调表示
     * @return {int}
     */
    getTone() {
        return this.data["tone"];
    }

    /**
     * 音节的声调得分等级
     * @return {int}
     */
    getToneScore() {
        return this.data["tonescore"];
    }

    /**
     * 带调发音等级：综合考虑了该字的 无调发音(phn)、声调(tone)
     * @return {int}
     */
    getPron() {
        return this.data["pron"];
    }

    /**
     * 无调发音等级
     * @return {int}
     */
    getPhn() {
        return this.data["phn"];
    }

    /**
     * 音节整体等级：综合考虑了该字的 无调发音(phn)、声调(tone)
     * @return {int}
     */
    getOverall() {
        return this.data["overall"];
    }

    /**
     * 获得phone数组的长度<br>
     * 如果是零声母，phone的数组只包括1个元素，表示韵母评分<br>
     * 否则phone数组包括2个元素，第1个表示声母评分，第2个表示韵母评分
     * @return {int}
     */
    getPhoneSize() {
        if(this.data["phone"]) {
            return this.data["phone"].length;
        }
        else {
            return 0;
        }
    }

    /**
     * 获得第i个phone
     * @param {int} i
     * @return {chivox.CnSentScore.Char.Phone}
     */
    getPhone(i) {
        if(this.data["phone"]) {
            var phoneI = this.data["phone"][i];
            return new Phone(phoneI);
        }
        else {
            return null;
        }
    }
}

/**
 * Phone 类，用于解析中文句子评分结果中details部分的phone<br>
 */
class Phone {
    constructor(data) { this.data = data; }

    /**
     * phone元素字符
     * @return {string}
     */
    getChar() {
        return this.data["char"];
    }

    /**
     * phone元素得分等级
     * @return {int}
     */
    getScore() {
        return this.data["score"];
    }
}

export default CnSentScore
